-
Notifications
You must be signed in to change notification settings - Fork 1.6k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Fix parsing of strings with special characters #11030
Fix parsing of strings with special characters #11030
Conversation
I'm not following, brackets |
@fdncred
I assume there is a reason for this piece of code to stay as it is so I changed the deparsing logic to take into account the possibility of parentheses in a string. |
But with this PR, it still works the same the way it does in your linked issue. ❯ ./echo.nu "5"
5
❯ ./echo.nu "hi(1)"
hi1
|
It does. Are you sure you're running it using nu built on this branch? I got the following output
|
I could've messed up. Lemme check again. |
oh, I see what I did. I used your script which was the problem, LOL. It has a shebang that points to a different nu executable. You're right, it works now. I won't be landing this though because it's changing the parser. We need someone more experienced with it to approve these changes. |
Marking this as draft since I might fix this issue together with #11035. |
Reopening with fix for the second issue |
One possible issue right now, my code might cause an error when parsing subcommand with a character that's not alphanumeric but I'm not sure what's the set of allowed characters in the subcommands to fix it |
I changed my implementation again, I think now it shouldn't break anything |
let's give this a try |
i labeled breaking change because i suspect it will be one, not that i've seen it break anything yet. |
<!-- if this PR closes one or more issues, you can automatically link the PR with them by using one of the [*linking keywords*](https://docs.github.com/en/issues/tracking-your-work-with-issues/linking-a-pull-request-to-an-issue#linking-a-pull-request-to-an-issue-using-a-keyword), e.g. - this PR should close #xxxx - fixes #xxxx you can also mention related issues, PRs or discussions! --> # Description <!-- Thank you for improving Nushell. Please, check our [contributing guide](../CONTRIBUTING.md) and talk to the core team before making major changes. Description of your pull request goes here. **Provide examples and/or screenshots** if your changes affect the user experience. --> If there were brackets in a string argument of a script it was always interpreted as interpolation before the change. That lead to unexpected outputs of such scripts. After this change arguments which are not intended as interpolation (not starting with $) and containing brackets will have implicitly added backticks for correct interpretation in the scripts. This fixes nushell#10908. To fix other issues mentioned in nushell#11035 I changed the deparsing logic. Initially we added backticks for multi word variables and double quote if there was \ or " in the string. My change would add double quotes any time string starts with $ or contains any of character that might break parsing. The characters I identified are white space, (, ', `, ",and \. It's possible other characters should be added to this list. I tested this solution with few simple scripts using both stand alone arguments and flags and it seems to work but I would appreciate if someone with more experience checked it with some more unusual cases I missed. # User-Facing Changes <!-- List of all changes that impact the user experience here. This helps us keep track of breaking changes. --> Erroneous behaviour described in the issue will no longer happen. # Tests + Formatting <!-- Don't forget to add tests that cover your changes. Make sure you've run and fixed any issues with these commands: - `cargo fmt --all -- --check` to check standard code formatting (`cargo fmt --all` applies these changes) - `cargo clippy --workspace -- -D warnings -D clippy::unwrap_used` to check that you're using the standard code style - `cargo test --workspace` to check that all tests pass (on Windows make sure to [enable developer mode](https://learn.microsoft.com/en-us/windows/apps/get-started/developer-mode-features-and-debugging)) - `cargo run -- -c "use std testing; testing run-tests --path crates/nu-std"` to run the tests for the standard library > **Note** > from `nushell` you can also use the `toolkit` as follows > ```bash > use toolkit.nu # or use an `env_change` hook to activate it automatically > toolkit check pr > ``` --> Added tests for new formatting. # After Submitting <!-- If your PR had any user-facing changes, update [the documentation](https://github.com/nushell/nushell.github.io) after the PR is merged, if necessary. This will help us keep the docs up to date. -->
Description
If there were brackets in a string argument of a script it was always interpreted as interpolation before the change. That lead to unexpected outputs of such scripts. After this change arguments which are not intended as interpolation (not starting with $) and containing brackets will have implicitly added backticks for correct interpretation in the scripts. This fixes #10908.
To fix other issues mentioned in #11035 I changed the deparsing logic. Initially we added backticks for multi word variables and double quote if there was \ or " in the string. My change would add double quotes any time string starts with $ or contains any of character that might break parsing. The characters I identified are white space, (, ', `, ",and . It's possible other characters should be added to this list.
I tested this solution with few simple scripts using both stand alone arguments and flags and it seems to work but I would appreciate if someone with more experience checked it with some more unusual cases I missed.
User-Facing Changes
Erroneous behaviour described in the issue will no longer happen.
Tests + Formatting
Added tests for new formatting.
After Submitting